docs: document and demonstrate the fluent Pipeline API - #275
Merged
Conversation
The pipeline was only lightly documented — the docfx Quick Start was an empty placeholder, no example project used the fluent API (all six demonstrate manual IAsyncEnumerable wiring), and DisposeStagesOnCompletion (added in #245) was undocumented while the README still claimed the pipeline 'never disposes' the stages you hand it. - docfx getting-started: replace the placeholder Quick Start with a full extractor/transformer/loader walkthrough, the fluent composition, and the optional capabilities (cancellation, progress, naming, stage disposal); fill the Prerequisites placeholder. - docfx introduction: real overview + key-features list covering the pipeline. - README: correct the stale 'never disposes' line and add a 'Disposing stages' subsection documenting DisposeStagesOnCompletion (reverse order, IAsyncDisposable preference, exception surfacing). - examples: add Example7-FluentPipeline (Net8.0 + Net4.8), a runnable end-to-end demonstration of Pipeline.Extract().Transform().Load().WithName().RunAsync(), wired into the solution. Both build clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This was referenced Jul 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes the pipeline documentation gap identified while reviewing #245.
Why
// Add your quick start code example here).IAsyncEnumerablewiring.DisposeStagesOnCompletion()(added in feat: opt-in Pipeline.DisposeStagesOnCompletion() (#133) #245) was undocumented, and the README still claimed the pipeline "never disposes the stages you hand it" — now false.What
getting-started.md— replaced the placeholder Quick Start with a complete walkthrough: implementing an extractor/transformer/loader, composing them withPipeline.Extract(...).Transform(...).Load(...).RunAsync(), and the optional capabilities (cancellation, progress, naming, stage disposal). Filled the Prerequisites placeholder.introduction.md— real overview + key-features list covering the pipeline.README.md— corrected the stale "never disposes" line and added a Disposing stages subsection (reverse-order teardown,IAsyncDisposablepreference, exception surfacing) matching theIPipelineXML docs.Example7-FluentPipeline(Net8.0 + Net4.8) — a runnable end-to-end demo of the fluent API, wired into the solution under the existingNet80/Net48folders.Verification
Example7projects build clean (0 warnings, 0 errors).dotnet restore ETL-Abstractions.slnsucceeds — the hand-checked solution wiring is valid.Docs + example only; no changes to
src/.